home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / psal10.zip / ARCID093.ZIP / ARCID.DOC < prev    next >
Text File  |  1992-05-17  |  13KB  |  318 lines
  1.  
  2.     ┌──────────────────────────────┐
  3.     │                              │
  4.     │  ╖────╖            ╖     ┐   │           Archive Identifier
  5.     │  ║    ║            ║     │   │
  6.     │  ║────╢ ┐──┐ ┌──┐  ║ ┌───│   │             Version 0.93ß
  7.     │  ║    ║ │    │     ║ │   │   │
  8.     │  ╜    ╜ ┘    └──┘  ╜ └───┘   │    (c) Copyright 1992 - Stacy Smith
  9.     │                              │
  10.     └──────────────────────────────┘
  11.  
  12.  
  13.                                 Courtesy of:
  14.  
  15.                         The Bloom Beacon-Picayune BBS
  16.                                (804) 525-9760
  17.                      300-14,400 Baud (USRobotics V.32bis)
  18.                               FidoNet 1:276/112
  19.                                   Intelec
  20.  
  21.                                 Stacy Smith
  22.                               Route 6 Box 189
  23.                            Forest, Virginia 24551
  24.  
  25.  
  26. ┌────────────────────┐
  27. │  1. Introduction:  │
  28. └────────────────────┘
  29.  
  30. Archive Identifier (ARCID) is a derivative of the UpLoadProcessor (ULP) system;
  31. users of ULP do not require this program, as each of the ULP programs have
  32. ARCID's abilities built into it.
  33.  
  34. ARCID is intended for use by people who wish to be able to accurately detect a
  35. archive's format without relying on the file extension, but do not wish to use
  36. ULP. These people may be sysops using EXZTEST, ZIPLAB, ZDCS, FWKCS, etc., may
  37. be using their own homemade batch files for testing archives, or even other
  38. purposes I haven't thought of.
  39.  
  40. Regardless, ARCID is an extremely simple and fast tool for people who deal with
  41. compressed files on a regular basis.
  42.  
  43.  
  44. ┌──────────────────────────────────────┐
  45. │  2. Features of Archive Identifier:  │
  46. └──────────────────────────────────────┘
  47.  
  48.       ∙ Identifies ARC, ARJ, HYP, LZH, PAK, ZIP, ZOO and GIF files, regardless
  49.         of their file extensions (ideal for software distribution networks,
  50.         like .SDN files).
  51.       ∙ Identifies ARJ, LZH, PAK and ZIP self-extracting (SFX) archives.
  52.       ∙ Can filter other file types based solely upon file extension.
  53.       ∙ A total of 97 archive formats and files extensions can be defined for
  54.         conditional branching of batch files.
  55.       ∙ Fully network-aware using DOS SHARE-compatible locks.
  56.       ∙ Written mostly in C (and a little assembler) for optimal speed, using
  57.         Borland C++ 3.0 and Turbo Assembler 3.0.
  58.       ∙ Lifetime registration; pay ONCE and your registration number will work
  59.         on all future versions!
  60.  
  61.  
  62. ┌───────────────────────────────────────────────────────┐
  63. │  3. Files Included in the ARCID Distribution Archive  │
  64. └───────────────────────────────────────────────────────┘
  65.  
  66.         ARCID.COM       Archive Identifier processing program.
  67.         ARCID.DOC       This file.
  68.         PCBTEST.BAT     Sample PCBTEST.BAT file for using ARCID.
  69.         REGISTER.FRM    Registration form for ARCID.
  70.         FILE_ID.DIZ     Internal description file.
  71.  
  72. When you unzip the distribution archive, you should see my PKZIP authenticity
  73. verification stamp, and a '-AV' after every file in the archive:
  74.  
  75.         # SSU301    The Bloom Beacon-Picayune BBS
  76.  
  77. If there are any files missing or added, or the -AV stamp is missing, the
  78. archive has been tampered with. It would be advisable to call my BBS (listed at
  79. the top of this document) for the latest version of ARCID.
  80.  
  81.  
  82. ┌───────────────────────────┐
  83. │  4. Program Requirements  │
  84. └───────────────────────────┘
  85.  
  86. To the best of my knowledge, this program will run on most any machine capable
  87. of running PCBoard 14.5+. I have personally tested and developed ARCID on the
  88. following machines, with no problems:
  89.  
  90.         10 MHz 80286 computer (CompuAdd) with:
  91.            ∙ PCBoard 14.5a/D
  92.            ∙ 1 megabyte of motherboard memory with a 4 megabyte EMS card
  93.            ∙ 115 megabytes of MFM hard disk space
  94.            ∙ MS-DOS 5.0 with 4DOS 4.0 command interpreter
  95.            ∙ EGA graphics subsystem
  96.            ∙ NAS16550AFN serial port UARTs
  97.            ∙ US Robotics Courier V.32bis external modem
  98.  
  99.         33 MHz 80486 computer (CompuAdd Express) with:
  100.            ∙ PCBoard 14.5a/E3
  101.            ∙ 8 megabytes of motherboard memory
  102.            ∙ 245 megabytes of IDE hard disk space
  103.            ∙ MS-DOS 5.0 with 4DOS 4.0 command interpreter
  104.            ∙ SVGA graphics subsystem
  105.            ∙ NAS16550AFN serial port UARTs
  106.            ∙ US Robotics Courier V.32bis external modem
  107.  
  108. Other sysops that I have been in contact with have successfully implemented
  109. ARCID on setups with CD-ROMs, networks (Ethernet and LANtastic) and other
  110. varying hardware.
  111.  
  112. ARCID has been developed and tested using archives created by the following
  113. archiving packages:
  114.  
  115.         ARJ 2.30 (by Robert Jung)
  116.         HYPER 2.5 (by P. Sawatzki and K. P. Nischke)
  117.         LHA 2.13 (by Haruyasu Yoshizaki)
  118.         LHarc 1.13c (by Haruyasu Yoshizaki)
  119.         PAK 2.51 (by NoGate Consulting)
  120.         PKPAK 3.61 (by PKWare)
  121.         PKZIP 1.10 (by PKWare)
  122.         PKZIP 1.93 Alpha (by PKWare)
  123.         ZOO 2.10 (by Rahul Deshi)
  124.  
  125. The ARCID system requires DOS 3.x or later, as it uses DOS SHARE-compatible
  126. file reads and writes.
  127.  
  128. ARCID memory requirements are extremely small (64K). It would be a good idea to
  129. have as much free conventional memory as possible (ARCID itself cannot use EMS
  130. or XMS memory, and really couldn't use it if I wanted to), especially if you
  131. use the ARJ compression system, which requires in the neighborhood of 280K
  132. itself to run.
  133.  
  134.  
  135. ┌───────────────────┐
  136. │  5. Registration  │
  137. └───────────────────┘
  138.  
  139. The ARCID system is not free; nor is ARCID is crippled to force registration.
  140. ARCID is fully functional, and will always remain so. The only variation with
  141. the registered copies is no beg message.
  142.  
  143. Why register? Besides a clean conscience, you will get a registration code that
  144. will work for all future versions of ARCID, and will remove the message at the
  145. end of execution of ARCID.
  146.  
  147. Also, registered users get a large time limit and unlimited downloading from
  148. my BBS, if they choose to do so...
  149.  
  150. The registration fee for your unique code is $5 for non-commercial BBSes. The
  151. registration fee for commercial BBSes, defined if you run your BBS in the
  152. course of a commercial business, or your if BBS turns a profit, is $10. Other
  153. variations are available; refer to the file REGISTER.FRM for all registration
  154. options. Please print the file REGISTER.FRM and fill it out. You can print out
  155. the form by issuing the following command from the DOS prompt:
  156.  
  157.         TYPE REGISTER.FRM > PRN
  158.  
  159.  
  160. ┌───────────────────────────────────────┐
  161. │  6. License, Warranty and Disclaimer  │
  162. └───────────────────────────────────────┘
  163.  
  164. I'll keep this part short and sweet, and dispense with the legal-ese:
  165.  
  166.         License: You are allowed to use ARCID for 30 days, after which you must
  167.            either register ARCID or stop using it completely. ARCID registration
  168.            is a license for your use of ARCID; I retain ownership of the
  169.            software. A single registration applies to a single BBS system,
  170.            regardless of the number of computers used in the system. If you run
  171.            two or more distinct BBS systems on the same computer (with different
  172.            names), you require two or more ARCID registrations. Refer to the
  173.            registration form for the currect pricing structure.
  174.  
  175.         Warranty: There isn't one. The only thing I'll guarantee is that ARCID
  176.            will take up disk space, and will disappear when deleted.
  177.  
  178.         Disclaimer: I'm not responsible for anything bad that happens. ARCID
  179.            works here, but I cannot be held responsible for it not working on
  180.            your computer or doing any damage to hardware or software.
  181.  
  182. If these aren't agreeable with you, then the best thing to do is delete ARCID
  183. right now. I'll do my best to help any user (registered or not) that wants to
  184. use ARCID, and I'll act on bug reports quickly, but I simply cannot and will
  185. not be responsible for anything bad, like lost data, disk crashes, or whatever
  186. else you can think of.
  187.  
  188.  
  189. ┌───────────────────┐
  190. │  7. Installation  │
  191. └───────────────────┘
  192.  
  193. GENERAL:
  194. ────────
  195. Copy the file ARCID.COM into a subdirectory that is included in the DOS path,
  196. so that ARCID may be executed from anywhere. I would suggest your PCB home
  197. directory, usually 'C:\PCB\'.
  198.  
  199. If you are running PCBoard under a network or a multitasking operating system,
  200. you should already have DOS's SHARE.EXE loaded. You must have SHARE loaded in
  201. order to take advantage of the file sharing and locking methods used by the
  202. ARCID program to prevent data loss. (If you are running a single-node system
  203. without a multitasker, SHARE is not needed).
  204.  
  205. Note that for the ARCID program, you can obtain a limited program syntax screen
  206. simply by executing the program with no arguments.
  207.  
  208. FOR UPLOAD TESTING USING 'PCBTEST.BAT':
  209. ───────────────────────────────────────
  210. NOTE: If you are unfamiliar with the operation of PCBTEST.BAT, you will need
  211. to refer to the PCBoard manual on pages 200-202 for an explanation of
  212. PCBTEST.BAT and TESTFILE.EXE.
  213.  
  214. As necessary, refer to the sample PCBTEST.BAT file included in this
  215. archive. This simple batch file will test archive integrity and check for
  216. viruses for any of the detectable formats of ARCID. This batch file can
  217. easily be expanded to perform more tests.
  218.  
  219. ARCID.COM is a drop-in replacement of PCBoard's TESTFILE.EXE. If you are
  220. already using TESTFILE.EXE, then simply replace the TESTFILE command in your
  221. batch file with ARCID. For example, if your current PCBTEST.BAT has the
  222. following line:
  223.  
  224.     TESTFILE %1 ZIP ARJ LZH GIF
  225.  
  226. simply change it to:
  227.  
  228.     ARCID %1 ZIP ARJ LZH GIF
  229.  
  230. ARCID will return a DOS errorlevel corresponding to the archive's position in
  231. the extension list. ARCID is capable of automatically detecting the formats
  232. identified by the following extensions, regardless of the file's true
  233. extension:
  234.  
  235.     ARC     for ARC/PKPAK archives
  236.     ARJ     for ARJ and ARJ self-extracting archives
  237.     GIF     for GIF files
  238.     HYP     for HYPER archives
  239.     LZH     for LHA/LHARC and LHA/LHARC self-extracting archives
  240.     PAK     for PAK and PAK self-extracting archives
  241.     ZIP     for PKZIP and PKZIP self-extracting archives
  242.     ZOO     for ZOO version 2.x archives
  243.  
  244. Do not add 'EXE' to the extension list; ARCID will automatically return to
  245. corresponding errorlevel for an identified self-extracting archive.
  246.  
  247.  
  248. ┌───────────────────────────────────────────┐
  249. │  8. Branding with Your Registration Code  │
  250. └───────────────────────────────────────────┘
  251.  
  252. To brand the ARCID executable with your registration code, type the following
  253. command from the DOS prompt:
  254.  
  255.     ARCID BRAND
  256.  
  257. ARCID will then ask you for your registration information (sysop name, BBS
  258. name and registration code). All of this information is case sensitive; you
  259. must enter it exactly as provided to you. After completion, ARCID will insert
  260. the codes inside of the executable, and the beg message will go away.
  261.  
  262. * NOTE: Do not attempt the brand an ARCID.COM executable that has been
  263.         compressed with PKLITE! This will corrupt the file, and may cause
  264.         ARCID to not function properly.
  265.  
  266.  
  267. ┌──────────────┐
  268. │  9. Support  │
  269. └──────────────┘
  270.  
  271. If you require support for ARCID, I can be contacted by any of the following
  272. means:
  273.  
  274.     ∙ Fidonet Netmail addressed to Stacy Smith, node 1:276/112 (aka 1:276/100)
  275.     ∙ Intelec Shareware conference
  276.     ∙ Intelec PCBoard conference
  277.     ∙ Salt Air (PCBoard support BBS)
  278.     ∙ The ARCID Support conference on my BBS (listed at the top of this
  279.         document).
  280.  
  281.  
  282. ┌───────────────────────────┐
  283. │  10. The Future of ARCID  │
  284. └───────────────────────────┘
  285.  
  286. ARCID will be supported as long as I'm in the BBSing business (which will be
  287. quite a while...once it's in your blood, you can never shake it <grin>). The
  288. ARCID system will be rapidly expanding it's features; some current plans:
  289.  
  290.       ∙ Incorporate code to detect archives containing explicit paths.
  291.       ∙ Incorporate code to detect defective or hacked archives.
  292.  
  293. If you have any other suggestions, or want other archivers supported, please
  294. contact me by U.S. snail-mail or on my BBS at the number at the top of this
  295. document.
  296.  
  297. Thanks for giving ARCID a try!
  298.  
  299.  
  300. ┌────────────────────────────────┐
  301. │  Appendix A:  DOS Errorlevels  │
  302. └────────────────────────────────┘
  303.  
  304. The errorlevels returned to DOS by the ARCID system programs are consistent
  305. among all of the programs (primarily with the error conditions); the following
  306. is a list of the errorlevels than can be returned by the ARCID programs, along
  307. with which programs return the codes:
  308.  
  309.         0       Successful brand of the ARCID executable
  310.         1-97    Successful execution, archive identified
  311.         98      Successful execution, archive NOT identified
  312.         99      Unsuccessful execution, no arguments passed (help screen
  313.                    displayed)
  314.         101     Unsuccessful brand of the ARCID executable
  315.         110     Unable to allocate heap memory
  316.         112     Invalid registration code
  317.         115     Invalid filename provided by user on command-line
  318.